﻿//-----------------------------------------------------------------------
// <copyright file="OtherUsersDataResult.cs" company="AFS">
// Copyright (c) AFS. All rights reserved.
//
//    This file is part of Chatbox.
//
//    Chatbox is free software: you can redistribute it and/or modify
//    it under the terms of the GNU Lesser General Public License as published by
//    the Free Software Foundation, either version 3 of the License, or
//    any later version.
//
//    Chatbox is distributed in the hope that it will be useful,
//    but WITHOUT ANY WARRANTY; without even the implied warranty of
//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
//    GNU Lesser General Public License for more details.
//
//    You should have received a copy of the GNU Lesser General Public License
//    along with Chatbox. If not, see http://www.gnu.org/copyleft/lesser.html
// </copyright>
//----------------------------------------------------------------------- 

namespace ChatBox.DomainObjects.ResultData
{
    using System;
    using System.Collections.Generic;

    using XmlFeedObjects;

    /// <summary>
    /// Result data containing other users
    /// </summary>
    public class OtherUsersDataResult : OperationResult
    {
        /// <summary>
        /// Initializes a new instance of the OtherUsersDataResult class
        /// </summary>
        /// <param name="success">the success flag</param>
        /// <param name="otherUsers">data about the other users on the server</param>
        /// <param name="message">the message to show</param>
        public OtherUsersDataResult(bool success, IEnumerable<OtherUser> otherUsers, string message)
        {
            this.Success = success;
            this.OtherUsers = otherUsers;
            this.Message = message;
        }

        /// <summary>
        /// Initializes a new instance of the OtherUsersDataResult class with a message
        /// </summary>
        /// <param name="success">the success flag</param>
        /// <param name="message">the error message</param>
        /// <param name="error">the exception</param>
        public OtherUsersDataResult(bool success, string message, Exception error)
        {
            this.Success = success;
            this.Message = message;
            this.Error = error;
        }

        /// <summary>
        /// Gets or sets the other users 
        /// </summary>
        public IEnumerable<OtherUser> OtherUsers { get; set; }
    }
}
